Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: remove 'variant' and 'static' attributes from coach indicator #4772

Merged

Conversation

rubencarvalho
Copy link
Collaborator

@rubencarvalho rubencarvalho commented Sep 18, 2024

Description

Removed the sp-coach-indicator "variant" and "static" attributes, along with all associated references and dependencies.

Related issue(s)

Motivation and context

For the upcoming 1.0.0 release of Spectrum Web Components, we will remove the deprecated components and features.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Chore (minor updates related to the tooling or maintenance of the repository, does not impact compiled assets)

Checklist

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • If my change required a change to the documentation, I have updated the documentation in this pull request.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I have reviewed at the Accessibility Practices for this feature, see: Aria Practices

Best practices

This repository uses conventional commit syntax for each commit message; note that the GitHub UI does not use this by default so be cautious when accepting suggested changes. Avoid the "Update branch" button on the pull request and opt instead for rebasing your branch against main.

@rubencarvalho rubencarvalho requested a review from a team as a code owner September 18, 2024 21:44
Copy link

Branch preview

Visual regression test results

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

Copy link

github-actions bot commented Sep 18, 2024

Lighthouse scores

Category Latest (report) Main (report) Branch (report)
Performance 0.99 0.99 0.99
Accessibility 1 1 1
Best Practices 1 1 1
SEO 1 0.92 0.92
PWA 1 1 1
What is this?

Lighthouse scores comparing the documentation site built from the PR ("Branch") to that of the production documentation site ("Latest") and the build currently on main ("Main"). Higher scores are better, but note that the SEO scores on Netlify URLs are artifically constrained to 0.92.

Transfer Size

Category Latest Main Branch
Total 228.276 kB 217.089 kB 🏆 217.25 kB
Scripts 57.714 kB 52.477 kB 🏆 52.691 kB
Stylesheet 34.637 kB 30.114 kB 🏆 30.118 kB
Document 6.222 kB 5.461 kB 5.461 kB
Font 126.84 kB 126.624 kB 🏆 126.631 kB

Request Count

Category Latest Main Branch
Total 52 52 52
Scripts 41 41 41
Stylesheet 5 5 5
Document 1 1 1
Font 2 2 2

Copy link

github-actions bot commented Sep 18, 2024

Tachometer results

Chrome

coachmark permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 682 kB 94.67ms - 96.95ms - faster ✔
5% - 8%
4.78ms - 8.05ms
branch 636 kB 101.05ms - 103.40ms slower ❌
5% - 8%
4.78ms - 8.05ms
-
Firefox

coachmark permalink

basic-test

Version Bytes Avg Time vs remote vs branch
npm latest 682 kB 186.61ms - 188.15ms - faster ✔
5% - 7%
9.03ms - 13.49ms
branch 636 kB 196.55ms - 200.73ms slower ❌
5% - 7%
9.03ms - 13.49ms
-

@rubencarvalho rubencarvalho marked this pull request as draft September 24, 2024 11:23
@rubencarvalho rubencarvalho added 1.0.0 Issues that should be addressed for a 1.0 release! Breaking labels Oct 15, 2024
@rubencarvalho rubencarvalho marked this pull request as ready for review October 15, 2024 12:03
@@ -219,6 +219,20 @@ jobs:
branch=$(npx slugify-cli $branch)
yarn netlify deploy --alias=$branch --cwd projects/documentation

beta-docs:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This shouldn't be in this PR

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bad rebase, fixed it now!

<sp-tab value="standard">Standard</sp-tab>
<sp-tab-panel value="standard">

```html
<sp-coach-indicator></sp-coach-indicator>
<sp-coach-indicator variant="dark"></sp-coach-indicator>
<sp-coach-indicator variant="light"></sp-coach-indicator>
<sp-coach-indicator static="dark"></sp-coach-indicator>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's not use static as a property!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed!

@@ -41,8 +41,8 @@ import { CoachIndicator } from '@spectrum-web-components/coachmark';

```html
<sp-coach-indicator quiet></sp-coach-indicator>
<sp-coach-indicator quiet variant="dark"></sp-coach-indicator>
<sp-coach-indicator quiet variant="light"></sp-coach-indicator>
<sp-coach-indicator quiet static="dark"></sp-coach-indicator>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's not use static as a property!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed!

@@ -22,14 +22,14 @@ export default {

export const staticWhite = (): TemplateResult => {
return html`
<sp-coach-indicator variant="white"></sp-coach-indicator>
<sp-coach-indicator quiet variant="white"></sp-coach-indicator>
<sp-coach-indicator static="white"></sp-coach-indicator>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's not use static as a property!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed!

@rubencarvalho rubencarvalho changed the title chore: remove 'variant' attribute from coach indicator chore: remove 'variant' and 'static' attributes from coach indicator Oct 16, 2024
@rubencarvalho rubencarvalho merged commit ab4e2e0 into ruben/remove-deprecations Oct 16, 2024
52 of 57 checks passed
@rubencarvalho rubencarvalho deleted the ruben/remove-coach-indicator branch October 16, 2024 15:19
rubencarvalho added a commit that referenced this pull request Oct 29, 2024
* chore: remove 'variant' and 'static' attributes from coach-indicator (#4772)

* chore: remove split-button component (#4729)

* chore: remove banner component (#4723)

* chore: remove deprecated badge  values (#4742)

* chore: remove sp-quick-actions (#4761)

* chore: remove popover's dialog property (#4751)

* chore: remove thumbnail deprecated sizes (#4760)

* chore: remove progress-circle overBackground property (#4750)

* chore: remove deprecated 'static' references (#4818)

* chore: remove action-button variant property (#4741)

* chore: remove 'theme' attribute from sp-theme (#4765)

* feat: add 1.0.0 migration guide (#4776)
rubencarvalho pushed a commit that referenced this pull request Oct 30, 2024
…4829)

- feat(styles): add Spectrum 2 styles
- feat(icons-workflow): add support for new Spectrum 2 icons (#4747)
- feat(icon): add support for Spectrum 2 icons (#4747)
- chore: remove pre-1.0.0 deprecations (#4828)
- feat(coach-indicator)!: remove 'variant' and 'static' attributes from coach-indicator (#4772)
- feat(split-button)!: remove split-button component (#4729)
- feat(banner)!: remove banner component (#4723)
- feat(badge)!: remove deprecated badge values (#4742)
- feat(quick-actions)!: remove sp-quick-actions (#4761)
- feat(popover)!: remove popover's dialog property (#4751)
- feat(thumbnail)!: remove thumbnail deprecated sizes (#4760)
- feat(progress-circle)!: remove progress-circle overBackground property (#4750)
- feat(action-button,action-group,action-menu,button,link,meter,progress-bar): remove deprecated 'static' references (#4818)
- feat(action-button)!: remove action-button variant property (#4741)
- feat(theme)!: remove 'theme' attribute from sp-theme (#4765)
- chore: make the spectrum-two theme fully functional (#4859)
- chore: add 1.0.0 migration guide (#4776)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1.0.0 Issues that should be addressed for a 1.0 release! Breaking
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants